import {BGMapMapBox} from 'gisplay-es6-webpack/src/Gisplay/Maps/Background Maps/BGMapMapBox.js'

public class | source

BGMapMapBox

BGMapWrapper → BGMapMapBox

MapBox as background map provider.

Constructor Summary

Public Constructor
public	constructor(bgmap: Object) Creates an instance of BGMapWrapper.

Public Methods
public	addClickEvent(map: Map) Add click event.
public	addEventListener(eventstr: string, eventfunction: Function): void Adds a listener to a specified event type.
public	addPanEvent(fun: Function) Add Pan/Drag event.
public	addZoomEvent(fun: Function) Add zoom event.
public	createCanvas(id: number): HTMLElement Given one id it creates a canvas object.
public	getBackgroundMapProviderObject(): bgMapObject Returns the background map object.
public	getCenterLat(): number Returns the latitude of the bounding box northwest corner.
public	getCenterLng(): number Returns the longitude of the bounding box northwest corner.
public	getContainer(): HTMLElement Returns the map's containing HTML element.
public	getHeight(): number Returns the height of the canvas element.
public	getWidth(): number Returns the width of the canvas elment.
public	getZoom(): number Returns the map's current zoom level.

From class BGMapWrapper
public	bgMapObject: Object This is the background map object that comes from the background map provider(e.g., MapBox).
public	loaderDiv: HTMLDivElement The div that contains the loader.
public	addClickEvent(map: Map) Add click event.
public	addEventListener(eventstr: string, eventfunction: Function): void Adds a listener to a specified event type.
public	addPanEvent(fun: Function) Add Pan/Drag event.
public	addZoomEvent(fun: Function) Add zoom event.
public	createCanvas(id: number): HTMLElement Given one id it creates a canvas object.
public	createLoader(): void Auxiliar method to be called when there is no loader and we want to create one.
public	getBackgroundMapProviderObject(): bgMapObject Returns the background map object.
public	getCenterLat(): number Returns the latitude of the bounding box northwest corner.
public	getCenterLng(): number Returns the longitude of the bounding box northwest corner.
public	getContainer(): HTMLElement Returns the map's containing HTML element.
public	getHeight(): number Returns the height of the canvas element.
public	getWidth(): number Returns the width of the canvas elment.
public	getZoom(): number Returns the map's current zoom level.
public	showLoader(): void Shows loader at the beginning when the API is loading the data.

Creates an instance of BGMapWrapper.

Name	Type	Attribute	Description
bgmap	Object		The background map object that came from the provider (e.g., Mapbox, Google Maps).

Add click event.

Name	Type	Attribute	Description
map	Map		The function to be called when the user clicks on the map.

Adds a listener to a specified event type.

Name	Type	Attribute	Description
eventstr	string		The event type to add a listen for.
eventfunction	Function		The function to be called when the event is fired. The listener function is called with the data object passed to fire , extended with target and type properties.